home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rabi_130.zip / RABI.DOC < prev    next >
Text File  |  1991-04-01  |  16KB  |  365 lines
  1.  
  2. ──────────────────────────────────────────────────────────────────────────────
  3.  
  4.                          for RA 1.0 and higher only !
  5.  
  6.                   │███████│    │██████│    │███████│   │██│        
  7.                  │██│   │██│  │██│  │██│  │██│   │██│  │██│        
  8.                  │██│   │██│        │██│  │██│   │██│  │██│        
  9.                  │████████│    │███████│  │████████│   │██│        
  10.                  │██│ │██│    │██│  │██│  │██│   │██│  │██│        
  11.                  │██│  │██│   │██│  │██│  │██│   │██│  │██│        
  12.                  │██│   │██│  │██│  │██│  │██│   │██│  │██│        
  13.                  │██│    │██│  │██████│    │███████│   │██│ v1.30
  14.  
  15.                        RABI, THE RemoteAccess Bimodem Shell
  16.                             Released April-2nd-1991
  17.                  (c) Copyright Ron Huiskes/InterSoft 1990 - 1991
  18.                               All Rights Reserved 
  19.  
  20.  
  21. ──────────────────────────────────────────────────────────────────────────────
  22.  ▓ INTRODUCTION
  23. ──────────────────────────────────────────────────────────────────────────────
  24.  
  25.  
  26.   Bimodem is a great program ! Every sysop should have it installed
  27.   on his bbs to offer the great advantages to the users of uploading
  28.   and downloading at the same moment.
  29.  
  30.   Bimodem is very easy to install in RemoteAccess, but then not every
  31.   limit and security can be controlled. And here is were RABI comes
  32.   in the picture. RABI is a bimodem shell for RemoteAcces. It uses all
  33.   the features Bimodem has, but keeps in mind the limits of the user.
  34.  
  35.  
  36. ──────────────────────────────────────────────────────────────────────────────
  37.  ▓ FEATURES OF RABI
  38. ──────────────────────────────────────────────────────────────────────────────
  39.  
  40.  
  41.   ■ RABI can be used as stand-alone door in RA, or it can be installed
  42.     as external protocol in config.ra.
  43.  
  44.   ■ RABI keeps control over the users time limit; users are returned
  45.     to the bbs when their time limit is exceeded. 
  46.  
  47.   ■ RABI keeps control over the users download limit, and will refuse
  48.     any download after this limit is reached. 
  49.  
  50.   ■ RABI keeps control over the directories a user has access to.
  51.  
  52.   ■ RABI keeps control over the descriptions of a file if a user
  53.     omit this when uploading.
  54.  
  55.   ■ RABI updates the users record number immediately after return to
  56.     the Bbs, the user can see directly was has happened. Only
  57.     succesfull down- and uploads will be recorded.
  58.  
  59.   ■ Users can enter files to download on-line in RABI, before executing
  60.     Bimodem on the Bbs ala filedoor, including wildcards and sysop 
  61.     definable default extension. (stand alone mode)
  62.  
  63.   ■ Full ANSI support, no ansi.sys required at sysops site.
  64.  
  65.   ■ DesqView Aware, gives up timeslices when detected.
  66.  
  67.   ■ Sysop definable hot Keys when using the menu shell.
  68.  
  69.   ■ Support for Ra's internal ratio system. If enabled RABI refuses
  70.     any download if the ratio of the user is not correct.
  71.  
  72.   ■ The name, location, baudrate, security level and timeleft are printed
  73.     under Bimodem, so you can exactly see who is online.    
  74.  
  75.   ■ RABI can make his own logfile if you want, AND logs every
  76.     succesfull transfer in the Ra.Log file (frontdoor or opus) including
  77.     filesize and cps rate.
  78.    
  79.   ■ When using stand alone mode the look of RABI is controlled by an
  80.     ascii/ansi textfile, which you can edit as you like. You can even
  81.     use control codes in it !
  82.  
  83.   ■ RABI has smart fossil functions and carrier detect routines.
  84.  
  85.   ■ Users can upload private files.
  86.  
  87.   ■ RABI can update your download counters in files.bbs. (stand alone only)
  88.      
  89.  
  90. ──────────────────────────────────────────────────────────────────────────────
  91.  ▓ BIMODEM INSTALLATION
  92. ──────────────────────────────────────────────────────────────────────────────
  93.  
  94.      
  95.   First, make sure you installed Bimodem correctly.  In the
  96.   FILENAMES AND PATHS section in the biconfig program there is
  97.   a line with: "Path of file listing directories that determine
  98.   rejections". Let this point to an ascii file with on every line
  99.   ALL your download directories in it. (Including the protected
  100.   ones for special users).
  101.  
  102.   There is another line with "Directory that files will be sent from."
  103.   This must point to another ascii file name. Make sure it contains a 
  104.   valid path. You don't have to make the file, RABI will make this at
  105.   every  start. It contains all the directory paths to which the user
  106.   has access to (from files.ra).
  107.  
  108.  
  109. ──────────────────────────────────────────────────────────────────────────────
  110.  ▓ RABI INSTALLATION
  111. ──────────────────────────────────────────────────────────────────────────────
  112.  
  113.  
  114.   RABI assumes the following:
  115.  
  116.   - That you have set the RA environment variable to point to
  117.     your system dir (where config.ra en files.ra are in).
  118.  
  119.   - That you have installed bimodem correctly.
  120.  
  121.   - That RABI can find Dorinfo1.def and Exitinfo.bbs in the
  122.     current dir.
  123.  
  124.   - That the RABI cfg file (RABI.CFG) is in the current dir.
  125.  
  126.  
  127. ──────────────────────────────────────────────────────────────────────────────
  128.  ▓ RABICFG.EXE
  129. ──────────────────────────────────────────────────────────────────────────────
  130.  
  131.  
  132.   The RABICFG.EXE program is the configuration program for RABI. It
  133.   creates the neccessary RABI.CFG file. With it you can control the
  134.   look and actions RABI takes.
  135.  
  136.   Most functions are not working when RABI is installed in protocol.ra,
  137.   but an RABI.CFG must exist.
  138.  
  139.   When you start RABICFG you have to fill in the path (and name) to your
  140.   bimodem.com and bimodem.cfg file. 
  141.  
  142.   On the third line you can give the path and name to a ascii & ansi file
  143.   which can be used as a menu. This file will be displayed when the user
  144.   enters RABI, to start the different options in RABI. (stand alone only)
  145.  
  146.   On the fourth and fifth line you can supply two other ascii/ansi files
  147.   which will be displayed when the user presses the hotkeys in the menu
  148.   shell. (stand alone only)
  149.  
  150.   On the last line of the first block you can supply a special logfile for
  151.   RABI. RABI itself is also hardcoded to write to your normal ra log, so
  152.   use this only if you want RABI to make a separate log. If you don't want
  153.   RABI to create a special log, just leave this line blank. 
  154.  
  155.   On the next set of lines you can change the colors RABI uses (just press
  156.   enter, and a box with options will be displayed), if RABI must update your
  157.   download counters, what default file extension it must use, and wether or
  158.   not you want RABI to ask if the user wants to hangup after transfers. 
  159.   Here you can also enable the option to let RABI check the ratios of the
  160.   user (depending on limits.ctl).
  161.  
  162.   The last set of lines can be used to change the hotkeys in the menu shell.
  163.   If you want to start bimodem directly when RABI is envoked, make all the
  164.   hotkeys blank (spaces), and RABI will start bimodem directly without using 
  165.   the menu shell. (stand alone only)
  166.  
  167.  
  168. ──────────────────────────────────────────────────────────────────────────────
  169.  ▓ INSTALLING RABI AS A SEPERATE DOOR
  170. ──────────────────────────────────────────────────────────────────────────────
  171.  
  172.  
  173.   In a users point of view this methode is the prefered way. Users can
  174.   choose themself how they want to start Bimodem and what they want to
  175.   down and/or upload.
  176.  
  177.   Installing RABI as a seperate door in RemoteAccess is like most other
  178.   doors. RABI doesn't need any parameters and as long as you have set
  179.   everything correctly in RABI.CFG your door will run without a problem.
  180.  
  181.   In the optional datafield in your menu you just put the complete path
  182.   and name of RABI (including extension) and you are ready to go.
  183.  
  184.   When you log on to your board locally you can check if RABI works 
  185.   correctly. Offcourse bimodem will not start because their will is no
  186.   carrier...
  187.  
  188.  
  189. ──────────────────────────────────────────────────────────────────────────────
  190.  ▓ INSTALLING RABI IN PROTOCOL.RA
  191. ──────────────────────────────────────────────────────────────────────────────
  192.  
  193.  
  194.  Well, after rewriting RABI's source code RABI can now also be installed
  195.  in protocol.ra. RA (and RABI) will update correctly the users limits, and
  196.  users can still add files for up/download with the ALT-A key in bimodem.
  197.  
  198.  To behave correctly from Protocol.ra you must set an 'DSZLOG' environment
  199.  variable to point to a logfile name. This file is used by RA to update
  200.  the users limits correctly. 
  201.  
  202.  In your protocol.ra, find a free slot, and fill in all the field as
  203.  follows: (replace the paths to RABI and your DSZ.LOG according to
  204.  your own setup)
  205.  
  206.                                                                           
  207.  Name                  : BiModem                            <- own choice  
  208.  Key                   : B                                  <- own choice  
  209.  Extended control file : No                                 <- better not  
  210.  Batch available       : Yes                                <- yes please  
  211.  Status                : Always available                   <- sure        
  212.  Log file name         : c:\ra\DSZ.LOG             <- dszlog environment   
  213.  Control file name     : files.lst                          <- hardcoded   
  214.  Download command line : c:\ra\doors\RABI.EXE /D   <- parameter hardcoded  
  215.  Upload command line   : EXIT             
  216.  Download ctl string   : @                                  <- hardcoded   
  217.  Upload ctl string     :                        
  218.  Download log keyword  : DL-B                               <- hardcoded   
  219.  Upload log keyword    :                                   
  220.  Log : Name word #     : 1                                  <- hardcoded   
  221.  Log : Desc word #     :                                                   
  222.                                                                            
  223.  
  224.  At this time RABI can only be started for Downloading (offcourse users
  225.  can add files for uploading). In the future also Uploading will be
  226.  implemented. 
  227.  
  228.  
  229. ──────────────────────────────────────────────────────────────────────────────
  230.  ▓ CONTROL CODES
  231. ──────────────────────────────────────────────────────────────────────────────
  232.  
  233.  
  234.   In the textfiles RABI uses when installed as a seperate door you can
  235.   use control codes to make the output of your choice. The following
  236.   are valid: 
  237.  
  238.   ^A   :  Pauses and wait for a key
  239.   ^FA  :  Users full name
  240.   ^FB  :  City
  241.   ^FO  :  Security level
  242.   ^FP  :  Calls to the Bbs
  243.   ^FQ  :  Number of Uploads
  244.   ^FR  :  Kilobytes of downloads  
  245.   ^FS  :  Number of Downloads
  246.   ^FT  :  Kilobytes of uploads                               
  247.   ^FW  :  First name only
  248.   ^KO  :  Minutes remaining today
  249.   ^KT  :  Daily download limit (in K)
  250.  
  251.  
  252. ──────────────────────────────────────────────────────────────────────────────
  253.  ▓ BEHAVIOUR
  254. ────────────────────────────────────────────────────────────────────────────── 
  255.  
  256.  
  257.   RABI has smart fossil and carrier detect routines. Don't worry about any-
  258.   thing. Is a user drops the carrier, Bimodem returns to RABI, and RABI 
  259.   immediately returns to the BBS. (After updating the user record, hehe :-)
  260.    
  261.   RABI will log every succesfull transfer in your logfile as specified in
  262.   Config.Ra. Also, RABI can make it's own logfile if you wish as specified
  263.   in the RABI.CFG file. In it every transfer is logged, also the ones that
  264.   the user aborted. If there by any change occurs an error, the online error
  265.   message will also be logged into this logfile.  RABI will only update the
  266.   users down and upload fields if they were succesfull transfered. If a file
  267.   is aborted or not found RABI does not take credit for it. (But a resumed
  268.   filetransfer will be credited.) RABI uses FILES.RA to find out to which
  269.   areas the user has access to, and passes them over to Bimodem.
  270.  
  271.  
  272. ──────────────────────────────────────────────────────────────────────────────
  273.  ▓ RATIO SYSTEM
  274. ────────────────────────────────────────────────────────────────────────────── 
  275.  
  276.  
  277.   The ratio system in Rabi is exactly the same as in Ra. If enabled RABI
  278.   will examine limits.ctl in your Ra system path and will refuse any
  279.   download if the users ratio is not correct.
  280.  
  281.   When the ratio system is enabled, make sure you have a RATIO.A* and
  282.   RATIOK.A* file in your textfile dir as set in raconfig. This will 
  283.   displayed to the user if he tries to enter filesnames online in Rabi.
  284.  
  285.  
  286. ──────────────────────────────────────────────────────────────────────────────
  287.  ▓ DISCLAIMER
  288. ──────────────────────────────────────────────────────────────────────────────
  289.  
  290.   - Legal mode on -
  291.  
  292.   The RABI package is supplied as is. The author disclaims all warranties,
  293.   expressed or implied, including, without limitation, the warranties of
  294.   merchantability and of fitness for  any purpose. The author assumes no
  295.   liability for damages, direct or consequential, which may result from
  296.   the use of RABI.
  297.  
  298.   RABI is a "shareware program" and is provided at no charge to the user
  299.   for evaluation. The essence of "user-supported" software is to provide
  300.   personal computer users with quality software without high prices, and
  301.   yet to provide incentive for programmers to continue to develop new
  302.   products.
  303.  
  304.   You are hereby granted a temporary license to use RABI for say 30 days
  305.   for evaluation. If you continue to use RABI after these 30 days you
  306.   need to register the software in order to get a permanent license.
  307.  
  308.   The RABI package, all programs, the documentation and support files
  309.   are copyrighted 1990-1991 by Ron Huiskes / InterSoft. All rights are
  310.   reserved. You may copy  this package for backup  purposes. You may also
  311.   copy and share unmodified copies of the whole package, providing that
  312.   the copyright notice is reproduced and included on all copies.
  313.  
  314.  
  315. ──────────────────────────────────────────────────────────────────────────────
  316.  ▓ REGISTERING
  317. ────────────────────────────────────────────────────────────────────────────── 
  318.  
  319.  
  320.   Regarding the time and effort i have put into this product, the
  321.   registration is simple and rather cheap.
  322.  
  323.   Payment of the registration fee, entitles you to:
  324.  
  325.     - The license for running one copy of the RABI-package on any
  326.       computer in a bbs system, including multiline sytems that
  327.       share the same file system 
  328.  
  329.     - A serial key that makes your copy of Rabi licensed to you.
  330.       This key file will work on every new version in the future.
  331.  
  332.   The price for a registration license is DFL 15,-
  333.  
  334.   After registering you receive a RABI key file that under no circumstances
  335.   must be made available to someone else.
  336.  
  337.   Why register ?
  338.  
  339.   Well, simpel: I think that if you can afford a BBS, a computer, a modem
  340.   and probably echoMail, then you also can afford to pay the software that
  341.   you use...
  342.  
  343.   Thank You for Your support.
  344.  
  345.  
  346. ──────────────────────────────────────────────────────────────────────────────
  347.  ▓ MORE QUESTIONS ?
  348. ────────────────────────────────────────────────────────────────────────────── 
  349.  
  350.  
  351.  If you have any questions, bug reports, bomb letters, or anything else
  352.  you like to get ride of: 
  353.  
  354.                           Ron Huiskes / Bbs Interface
  355.                                  P.o. Box 528
  356.                                2280 AM Rijswijk
  357.                                    Holland
  358.                          
  359.                         +31-70-3361380 / +31-70-3361381
  360.          
  361.                             [2:281/506@fidonet.eur] 
  362.  
  363. ──────────────────────────────────────────────────────────────────────────────
  364. <EOF>
  365.